Skip to content

fix: Remove non-functional rate control params from GitHub connector docs#1713

Merged
lukekim merged 1 commit into
trunkfrom
fix/github-rate-params-clean
May 14, 2026
Merged

fix: Remove non-functional rate control params from GitHub connector docs#1713
lukekim merged 1 commit into
trunkfrom
fix/github-rate-params-clean

Conversation

@claudespice
Copy link
Copy Markdown
Collaborator

The GitHub connector docs list 4 HTTP rate control parameters that are not in the connector PARAMETERS array and are silently ignored. The GitHub connector uses its own rate limiter based on X-RateLimit-* headers, not the generic HTTP rate control mechanism. Removed the 4 non-functional parameters while keeping max_concurrent_requests which IS wired in. Verified against spiceai/spiceai trunk.

…docs

The GitHub connector does not consume requests_per_second_limit,
requests_per_minute_limit, rate_control_jitter_min, or
rate_control_jitter_max — they are not in the connector's ParameterSpec
array. The GitHub connector uses its own rate limiter based on GitHub
API X-RateLimit-* response headers, not the generic HTTP rate control
mechanism. Users setting these params have them silently ignored.

Keep max_concurrent_requests which IS wired into the connector.
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 11, 2026

✅ Pull with Spice Passed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected
  • ✅ Has at least one assignee: claudespice

@github-actions
Copy link
Copy Markdown

🔍 Pull with Spice Failed

Passing checks:

  • ✅ Title meets minimum length requirement (10 characters)
  • ✅ Has at least one of the required labels: area/blog, area/docs, area/cookbook, dependencies
  • ✅ No banned labels detected

Failed checks:

  • ❌ At least one assignee is required for this pull request.

Please address these issues and update your pull request.

@github-actions
Copy link
Copy Markdown

🚀 deployed to https://3c12b2e3.spiceai-org-website.pages.dev

@lukekim lukekim merged commit 033cc95 into trunk May 14, 2026
6 of 9 checks passed
@lukekim lukekim deleted the fix/github-rate-params-clean branch May 14, 2026 04:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants